
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" lang="Python">
  <head>
    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>notebook module &#8212; deepaugment 0.2.0 documentation</title>
    <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <script type="text/javascript" src="_static/language_data.js"></script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
   
  <link rel="stylesheet" href="_static/custom.css" type="text/css" />
  
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head><body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            
  <div class="section" id="module-notebook">
<span id="notebook-module"></span><h1>notebook module<a class="headerlink" href="#module-notebook" title="Permalink to this headline">¶</a></h1>
<dl class="class">
<dt id="notebook.Notebook">
<em class="property">class </em><code class="descclassname">notebook.</code><code class="descname">Notebook</code><span class="sig-paren">(</span><em>config</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/notebook.html#Notebook"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#notebook.Notebook" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<dl class="method">
<dt id="notebook.Notebook.add_records_from">
<code class="descname">add_records_from</code><span class="sig-paren">(</span><em>notebook_path</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/notebook.html#Notebook.add_records_from"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#notebook.Notebook.add_records_from" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="notebook.Notebook.get_top_policies">
<code class="descname">get_top_policies</code><span class="sig-paren">(</span><em>k</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/notebook.html#Notebook.get_top_policies"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#notebook.Notebook.get_top_policies" title="Permalink to this definition">¶</a></dt>
<dd><p>Prints and returns top-k policies</p>
<p>Policies are ordered by their expected accuracy increas
Args:</p>
<blockquote>
<div>k (int) top-k</div></blockquote>
<dl class="docutils">
<dt>Returns</dt>
<dd>pandas.DataFrame: top-k policies as dataframe</dd>
</dl>
</dd></dl>

<dl class="method">
<dt id="notebook.Notebook.output_top_policies">
<code class="descname">output_top_policies</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/notebook.html#Notebook.output_top_policies"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#notebook.Notebook.output_top_policies" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="notebook.Notebook.record">
<code class="descname">record</code><span class="sig-paren">(</span><em>trial_no</em>, <em>trial_hyperparams</em>, <em>sample_no</em>, <em>reward</em>, <em>history</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/notebook.html#Notebook.record"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#notebook.Notebook.record" title="Permalink to this definition">¶</a></dt>
<dd><p>Records one complete training of child model</p>
<dl class="docutils">
<dt>Args:</dt>
<dd>trial_no (int): no of trial (iteration) of training
trial_hyperparams (list) : list of data augmentation hyperparameters used for training
sample_no (int): sample no among training with same hyperparameters
reward (float): reward is basically last n validation accuracy before overfitting
history (dict): history returned by keras.model.fit()</dd>
</dl>
</dd></dl>

<dl class="method">
<dt id="notebook.Notebook.save">
<code class="descname">save</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/notebook.html#Notebook.save"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#notebook.Notebook.save" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="function">
<dt id="notebook.get_folder_path">
<code class="descclassname">notebook.</code><code class="descname">get_folder_path</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/notebook.html#get_folder_path"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#notebook.get_folder_path" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</div>


          </div>
          
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">deepaugment</a></h1>








<h3>Navigation</h3>

<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="index.html">Documentation overview</a><ul>
  </ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
  <h3>Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    </div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>








        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      &copy;2019, Baris Ozmen.
      
      |
      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.8.3</a>
      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
      
      |
      <a href="_sources/notebook.rst.txt"
          rel="nofollow">Page source</a>
    </div>

    

    
  </body>
</html>